/*
 * Copyright 2002-2007 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.core.io.support;

import java.io.IOException;

import org.springframework.core.io.Resource;
import org.springframework.core.io.ResourceLoader;

/**
 * ResourceLoader 的扩展，它支持根据指定的资源路径匹配模式每次返回**多个** Resource 实例
 *
 * 它是一个策略接口，用于将位置模式（例如，Ant 样式的路径模式）解析为 Resource 对象。
 * 这是 ResourceLoader 接口的扩展。可以检查传入的 ResourceLoader（例如，在上下文中运行时通过
 * ResourceLoaderAware 传入的 ApplicationContext ）是否也实现了此扩展接口。
 *
 * 这一段列出了一种 ResourcePatternResolver 的独立实现：基于路径匹配的解析器，
 * 这种扩展实现的特点是会根据特殊的路径来返回多个匹配到的资源文件。
 *
 * 可以与任何类型的位置模式一起使用（例如 "/WEB-INF/*-context.xml" ）：
 * 输入模式必须与策略实现相匹配。该接口仅指定转换方法，而不是特定的模式格式。
 *
 * 此接口还为类路径中的所有匹配资源建议一个新的资源前缀 "classpath*: "。
 * 请注意，在这种情况下，资源位置应该是没有占位符的路径（例如 "/beans.xml" ）；
 * jar 文件或类目录可以包含多个相同名称的文件。
 *
 * @author Juergen Hoeller
 * @since 1.0.2
 * @see org.springframework.core.io.Resource
 * @see org.springframework.core.io.ResourceLoader
 * @see org.springframework.context.ApplicationContext
 * @see org.springframework.context.ResourceLoaderAware
 */
public interface ResourcePatternResolver extends ResourceLoader {

	/**
	 * Pseudo URL prefix for all matching resources from the class path: "classpath*:"
	 * This differs from ResourceLoader's classpath URL prefix in that it
	 * retrieves all matching resources for a given name (e.g. "/beans.xml"),
	 * for example in the root of all deployed JAR files. 所有的 Jar
	 * @see org.springframework.core.io.ResourceLoader#CLASSPATH_URL_PREFIX
	 */
	String CLASSPATH_ALL_URL_PREFIX = "classpath*:"; // CLASSPATH URL 前缀。默认为："classpath*:" ，和 ResourceLoader 的 "classpath:" 不同。

	/**
     * 返回多个 Resource 对象
     *
	 * Resolve the given location pattern into Resource objects.
	 * <p>Overlapping resource entries that point to the same physical
	 * resource should be avoided, as far as possible. The result should
	 * have set semantics.
	 * @param locationPattern the location pattern to resolve
	 * @return the corresponding Resource objects
	 * @throws IOException in case of I/O errors
	 */
	Resource[] getResources(String locationPattern) throws IOException;

}
